Truck Driver

 

 

 

CreateNewDriver

The business task creates a new truck driver record using data, such as driver name and license number, entered by a gate clerk.

If the truck driver record already exists but is in the Obsolete lifecycle state, this business task changes the state of the same truck driver record as Active instead of adding a new record.

Functional Area

Appointment and Gate

Execution Level

Transaction/Truck Visit

Transaction Type(s)

Appointment: Truck Visit APPTTV, Through Container (TC)

Gate: Deliver Break-Bulk (DB), Deliver Chassis (DC), Dray Off (DE), Deliver Import (DI), Deliver Empty (DM), Receive Break-Bulk (RB), Receive Chassis (RC), Receive Export (RE), Dray In (RI), Receive Empty (RM), Through Container (TC)

Timing

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

To successfully add a new truck driver record, you must include the Driver Name and Driver License form fields in the appropriate Trk Visit form (on page 1) and the gate clerk must enter data in both the fields at the gate.

Related Business Task(s)

None

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

Field(s)

Driver Name

Driver License

 

RejectDriverBanned

Rejects a gate transaction if the specified truck driver is banned from the facility. For more information, see Driver form (on page 1).

Appointment stage

Gate stage

Truck Visit

Deliver Chassis (DC)

Dray Off (DE)

Deliver Import (DI)

Deliver Empty (DM)

Receive Break-Bulk (RB)

Receive Chassis (RC)

Receive Export (RE)

Dray In (RI)

Receive Empty (RM)

Through Container (TC)

Deliver Break-Bulk (DB)

Deliver Chassis (DC)

Dray Off (DE)

Deliver Import (DI)

Deliver Empty (DM)

Receive Break-Bulk (RB)

Receive Chassis (RC)

Receive Export (RE)

Dray In (RI)

Receive Empty (RM)

Through Container (TC)

 

 

RejectDriverHazLicExpired

Rejects a gate transaction with hazardous material if the truck driver's hazardous materials license has expired. For more information, see Driver form (on page 1).

See also RejectDriverNoHazLicense (on page 1) and ApplyContainerHazards (on page 1).

Appointment stage

Gate stage

Deliver Import (DI)

Receive Export (RE)

Through Container (TC)

Deliver Break-Bulk (DB)

Dray Off (DE)

Deliver Import (DI)

Receive Export (RE)

Dray In (RI)

Through Container (TC)

 

 

RejectDriverNoHazLicense

Rejects a gate transaction with hazardous material if the truck driver does not have a hazardous materials license. For more information, see Driver form (on page 1).

See also RejectDriverHazLicExpired (on page 1) and ApplyContainerHazards (on page 1).

Appointment stage

Gate stage

Deliver Import (DI)

Receive Export (RE)

Through Container (TC)

Deliver Break-Bulk (DB)

Dray Off (DE)

Deliver Import (DI)

Receive Export (RE)

Dray In (RI)

Through Container (TC)

 

 

RejectDriverNotApprovedForHazards

Rejects hazardous transactions when the driver does not have a valid hazardous license. This task checks the value of the is-hazard-licensed attribute of the driver element of the create-truck-visit and process-truck gate APIs.

Appointment stage

Gate stage

Deliver Import (DI)

Receive Export (RE)

Through Container (TC)

Deliver Break-Bulk (DB)

Dray Off (DE)

Deliver Import (DI)

Receive Export (RE)

Dray In (RI)

Through Container (TC)

 

 

RejectDriverNotProvided

Rejects a gate transaction without a Driver License or Driver Card ID specified.

Appointment stage

Gate stage

Truck Visit

Deliver Break-Bulk (DB)

Deliver Chassis (DC)

Dray Off (DE)

Deliver Import (DI)

Deliver Empty (DM)

Receive Break-Bulk (RB)

Receive Chassis (RC)

Receive Export (RE)

Dray In (RI)

Receive Empty (RM)

Through Container (TC)

Deliver Break-Bulk (DB)

Deliver Chassis (DC)

Dray Off (DE)

Deliver Import (DI)

Deliver Empty (DM)

Receive Break-Bulk (RB)

Receive Chassis (RC)

Receive Export (RE)

Dray In (RI)

Receive Empty (RM)

Through Container (TC)

Truck Visit IN

Truck Visit OUT

 

 

RejectDriverSuspended

Rejects a gate transaction if the specified truck driver has been suspended from the facility. For more information, see Driver form (on page 1).

Appointment stage

Gate stage

Truck Visit

Deliver Break-Bulk (DB)

Deliver Chassis (DC)

Dray Off (DE)

Deliver Import (DI)

Deliver Empty (DM)

Receive Break-Bulk (RB)

Receive Chassis (RC)

Receive Export (RE)

Dray In (RI)

Receive Empty (RM)

Through Container (TC)

Deliver Break-Bulk (DB)

Deliver Chassis (DC)

Dray Off (DE)

Deliver Import (DI)

Deliver Empty (DM)

Receive Break-Bulk (RB)

Receive Chassis (RC)

Receive Export (RE)

Dray In (RI)

Receive Empty (RM)

Through Container (TC)

 

 

RejectDriverUnknown

Rejects a gate transaction if the specified truck driver record does not exist or is Obsolete.

You can also use this business task to reject a gate transaction when the CreateNewDriver (on page 1) business task is included but cannot create a new driver record using the information entered at the gate.

Appointment stage

Gate stage

Truck Visit

Deliver Break-Bulk (DB)

Deliver Chassis (DC)

Dray Off (DE)

Deliver Import (DI)

Deliver Empty (DM)

Receive Break-Bulk (RB)

Receive Chassis (RC)

Receive Export (RE)

Dray In (RI)

Receive Empty (RM)

Through Container (TC)

Deliver Break-Bulk (DB)

Deliver Chassis (DC)

Dray Off (DE)

Deliver Import (DI)

Deliver Empty (DM)

Receive Break-Bulk (RB)

Receive Chassis (RC)

Receive Export (RE)

Dray In (RI)

Receive Empty (RM)

Through Container (TC)

Truck Visit IN

Truck Visit OUT

 

 

RejectGosTvKeyMismatchForDriver

The business task rejects a gate transaction if it receives two create-truck-visit or process-truck API calls containing different GOS (gate operating system) Truck Visit GKeys (truck-visit gos-tv-key) but the same Driver ID (driver card-id). N4 compares the truck-visit gos-tv-key with the scanGostvGkey and displays an error message if the two do not match.

Functional Area

Gate

Execution Level

Truck Visit

Transaction Type(s)

Gate: Truck Visit IN and Truck Visit OUT

Timing

N4 processes this business task when creating a truck visit or when you click the Save Transaction button on the <GateStage> tab for the first gate transaction.

If any pre-stage business task fails at the first gate stage, N4 does not create a truck visit, and does not allow the user to send the truck to Trouble.

Client Type(s)

Gate API

Parameters

None

Dependencies

When you include the RejectGosTvKeyMismatchForDrive business task at the Truck Visit IN/OUT gate stage, you must also include the <lane-id> element in the create-truck-visit or process-truck API calls for the expected results. This is because the business task validates the truck-visit gos-tv-key based on the Lane-ID.

Related Business Task(s)

None

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

Field(s)

None

 

UpdateDriver

Updates the last truck driver for the specified truck and the driver name, driver ID, and card ID for the driver specified in the truck visit.

Gate stage

Deliver Break-Bulk (DB)

Truck Visit IN